Documented the pe::header::DosHeader. #393
Conversation
| /// 0x0002 (2 pages); if the file contained 1025 bytes, this word would contain 0x0003 (3 pages). | ||
| /// [Source](https://stixproject.github.io/data-model/1.2/WinExecutableFileObj/DOSHeaderType/). | ||
| /// | ||
| /// Typically, this field is set to 0. [Source](https://offwhitesecurity.dev/malware-development/portable-executable-pe/dos-header/). |
There was a problem hiding this comment.
this is probably fine, but at first, I wasn't sure how i feel about linking to a website for PE malware development in the doc comments to be honest :) however, this disclaimer does say it's just for educational purposes https://offwhitesecurity.dev/malware-development/ so i guess its ok ... 🤷
There was a problem hiding this comment.
It just happened so that this was a website that told about such details as typical values for the fields.
|
I have to ask, was the documentation generated using some form of automation or with an AI assistant? |
|
release note: non-breaking |
For the most part, the documentation was written manually with the assistance of GitHub Copilot. There was a small exception, though. I haven't found a website with decent explanation of one topic of Program Segment Prefix (PSP) so I fact-checked the paragraph generated by ChatGPT and used it to make the part about PSP easier to understand. |
I've noticed that there was little to no documentation of the DOS header, so I decided to add it. I've provided sources for all the claims that are made in the docs.